﻿using System;
using System.Collections.Generic;

namespace Flagwind.Plugins
{
	/// <summary>
	/// 表示构建器的接口。
	/// </summary>
	public interface IBuilder : IDisposable
	{
		/// <summary>
		/// 获取构建器对应指定构件的构建结果的类型。
		/// </summary>
		Type GetValueType(Builtin builtin);

		/// <summary>
		/// 创建指定构件对应的目标对象。
		/// </summary>
		/// <returns>创建成功后的目标对象，有关该返回值的详细定义请参考说明部分。</returns>
		/// <remarks>
		///		<para>该方法返回值会被作为对应<see cref="Builtin"/>的子构件对应目标对象的所有者(即上级对象)。</para>
		///		<para>如果该方法内部设置了<param name="context"/>参数对象中的<seealso cref="Builders.BuilderContext.Result"/>属性不为空(null)。</para>
		/// </remarks>
		object Build(Builders.BuilderContext context);

		/// <summary>
		/// 当创建完成后由创建管理器调用。
		/// </summary>
		/// <param name="context">指定的创建器上下文对象。</param>
		/// <remarks>
		///		<para>注意：对于创建器的实现者，请在本方法内实现将目标对象添加到所有者对应的子集中去的逻辑，切勿在<see cref="Build"/>方法中实现添加逻辑，因为构建逻辑可被外部调用者覆盖，因此务必将创建于添加子集的逻辑分别处理。</para>
		/// </remarks>
		void OnBuilt(Builders.BuilderContext context);

		/// <summary>
		/// 卸载指定构件对应的目标对象。
		/// </summary>
		void Destroy(Builders.BuilderContext context);
	}
}